\section{TubeScreamer Class Reference}
\label{class_tube_screamer}\index{TubeScreamer@{TubeScreamer}}
Inheritance diagram for TubeScreamer:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{class_tube_screamer}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
{\bf TubeScreamer} ()
\item 
{\bf TubeScreamer} (double volume, double gain, double tone, double dirty)
\item 
{\bf $\sim$TubeScreamer} ()
\item 
int {\bf processSound} (void $\ast$outputBuffer, void $\ast$inputBuffer, void $\ast$data)
\end{DoxyCompactItemize}


\subsection{Constructor \& Destructor Documentation}
\index{TubeScreamer@{TubeScreamer}!TubeScreamer@{TubeScreamer}}
\index{TubeScreamer@{TubeScreamer}!TubeScreamer@{TubeScreamer}}
\subsubsection[{TubeScreamer}]{\setlength{\rightskip}{0pt plus 5cm}TubeScreamer::TubeScreamer (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}\label{class_tube_screamer_ac13e4698735c26be12da272f02e359e0}
Default constructor for the \doxyref{TubeScreamer}{p.}{class_tube_screamer} effect with middle values for volume, gain, and tone \index{TubeScreamer@{TubeScreamer}!TubeScreamer@{TubeScreamer}}
\index{TubeScreamer@{TubeScreamer}!TubeScreamer@{TubeScreamer}}
\subsubsection[{TubeScreamer}]{\setlength{\rightskip}{0pt plus 5cm}TubeScreamer::TubeScreamer (
\begin{DoxyParamCaption}
\item[{double}]{volume, }
\item[{double}]{gain, }
\item[{double}]{tone, }
\item[{double}]{dirty}
\end{DoxyParamCaption}
)}\label{class_tube_screamer_a2d94039ca2f6f2471146a54124ab1b59}
Constructor for the \doxyref{TubeScreamer}{p.}{class_tube_screamer} effect that specifies values for volume, gain, and tone.


\begin{DoxyParams}{Parameters}
{\em volume} & A value between 0 and 100 specifying the amount of post-\/overdrive amplification of the signal\\
\hline
{\em gain} & A value between 0 and 100 specifying the amount of distortion to be added to the signal\\
\hline
{\em tone} & A double between 0 and 100 that changes the output tone of the Tube Screamer (0 corresponds to a more muddy, bassy sound whereas 100 corresponds to a more trebly sound).\\
\hline
{\em dirty} & A double between 0 and 100 that specifies the relative level of the distorted signal to the clean signal \\
\hline
\end{DoxyParams}
\index{TubeScreamer@{TubeScreamer}!$\sim$TubeScreamer@{$\sim$TubeScreamer}}
\index{$\sim$TubeScreamer@{$\sim$TubeScreamer}!TubeScreamer@{TubeScreamer}}
\subsubsection[{$\sim$TubeScreamer}]{\setlength{\rightskip}{0pt plus 5cm}TubeScreamer::$\sim$TubeScreamer (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}\label{class_tube_screamer_aab07789c48d61647c94d73159fdf2898}
Destructor for the \doxyref{TubeScreamer}{p.}{class_tube_screamer} class 

\subsection{Member Function Documentation}
\index{TubeScreamer@{TubeScreamer}!processSound@{processSound}}
\index{processSound@{processSound}!TubeScreamer@{TubeScreamer}}
\subsubsection[{processSound}]{\setlength{\rightskip}{0pt plus 5cm}int TubeScreamer::processSound (
\begin{DoxyParamCaption}
\item[{void $\ast$}]{outputBuffer, }
\item[{void $\ast$}]{inputBuffer, }
\item[{void $\ast$}]{data}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  [virtual]}}\label{class_tube_screamer_a0d93e07873d1389b717410fad32adcae}
Function that processes the data from the input buffer through an emulator of the Ibanez Tube Screamer pedal to produce an overdriven version of the input buffer at the output buffer.


\begin{DoxyParams}{Parameters}
{\em outputBuffer} & The buffer of data to be written to the output of the program (currently the speakers of the computer)\\
\hline
{\em inputBuffer} & The buffer of data read from the input to the program (either the line-\/in port or the built-\/in microphone)\\
\hline
{\em data} & A pointer to a \doxyref{processData}{p.}{structprocess_data} struct cast as a void$\ast$\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
An integer encoding information about the successful execution of this function. A zero indicates successful execution with no problems. 
\end{DoxyReturn}


Implements {\bf Effect} \doxyref{}{p.}{class_effect_a86eecaef68cf5e0ba3d4326759d39235}.



The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
\item 
Include/{\bf TubeScreamer.h}\end{DoxyCompactItemize}
